// Protocol Buffers for GWT
// Copyright 2010 Thomas Broyer  All rights reserved.
// http://code.google.com/p/protobuf-gwt/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package net.ltgt.gwt.protobuf.compiler;

import com.google.protobuf.Descriptors.FileDescriptor;
import com.google.protobuf.compiler.CodeGenerator;
import com.google.protobuf.compiler.JavaHelpers;

import net.ltgt.gwt.protobuf.compiler.client.Generator;

import java.io.IOException;
import java.io.Writer;

/**
 * @author t.broyer@ltgt.net Thomas Broyer
 * Based on the initial work of:
 * @author kenton@google.com Kenton Varda
 * Based on original Protocol Buffers design by
 * Sanjay Ghemawat, Jeff Dean, and others.
 */
public class AbstractFileGenerator {

  protected final FileDescriptor file;
  protected final String javaPackage;

  public AbstractFileGenerator(FileDescriptor file) {
    this.file = file;
    this.javaPackage = JavaHelpers.getFileJavaPackage(file);
  }

  protected void generateFileHeader(Writer output) throws IOException {
    output.write("// Generated by the GWT protocol buffer compiler code generator plugin. DO NOT EDIT.\n");
    output.write("// source: " + file.getName() + "\n\n");

    if (!javaPackage.isEmpty()) {
      output.write("package " + javaPackage + ";\n");
      output.write("\n");
    }
  }

  protected void generateSibling(Generator generator, String packageDir,
      CodeGenerator.Context context) throws IOException {
    String filename = packageDir + generator.getName() + ".java";

    Writer output = context.open(filename);
    try {
      generateFileHeader(output);

      generator.generate(output);
    } finally {
      output.close();
    }
  }
}